<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>MapUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/com/qrmedia/commons/collections/MapUtils.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * @(#)MapUtils.java     24 Nov 2008</em>
<a name="3" href="#3">3</a>   <em class="comment"> * </em>
<a name="4" href="#4">4</a>   <em class="comment"> * Copyright © 2009 Andrew Phillips.</em>
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
<a name="6" href="#6">6</a>   <em class="comment"> * This program is free software: you can redistribute it and/or modify</em>
<a name="7" href="#7">7</a>   <em class="comment"> * it under the terms of the GNU General Public License as published by</em>
<a name="8" href="#8">8</a>   <em class="comment"> * the Free Software Foundation, either version 3 of the License, or</em>
<a name="9" href="#9">9</a>   <em class="comment"> * (at your option) any later version.</em>
<a name="10" href="#10">10</a>  <em class="comment"> *</em>
<a name="11" href="#11">11</a>  <em class="comment"> * This program is distributed in the hope that it will be useful,</em>
<a name="12" href="#12">12</a>  <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em>
<a name="13" href="#13">13</a>  <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</em>
<a name="14" href="#14">14</a>  <em class="comment"> * GNU General Public License for more details.</em>
<a name="15" href="#15">15</a>  <em class="comment"> *</em>
<a name="16" href="#16">16</a>  <em class="comment"> * You should have received a copy of the GNU General Public License</em>
<a name="17" href="#17">17</a>  <em class="comment"> * along with this program. If not, see &lt;<a href="http://www.gnu.org/licenses/" target="alexandria_uri">http://www.gnu.org/licenses/</a>>.</em>
<a name="18" href="#18">18</a>  <em class="comment"> */</em>
<a name="19" href="#19">19</a>  <strong>package</strong> com.qrmedia.commons.collections;
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.HashMap;
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.Map;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <em>/**<em>*</em></em>
<a name="25" href="#25">25</a>  <em> * Utility methods for {@link Map Maps}.</em>
<a name="26" href="#26">26</a>  <em> * </em>
<a name="27" href="#27">27</a>  <em> * @author anph</em>
<a name="28" href="#28">28</a>  <em> * @see org.apache.commons.collections.MapUtils</em>
<a name="29" href="#29">29</a>  <em> * @since 24 Nov 2008</em>
<a name="30" href="#30">30</a>  <em> *</em>
<a name="31" href="#31">31</a>  <em> */</em>
<a name="32" href="#32">32</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../com/qrmedia/commons/collections/MapUtils.html">MapUtils</a> {
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>      <em>/**<em>*</em></em>
<a name="35" href="#35">35</a>  <em>     * Puts all the keys and values from the specified array into a new map.</em>
<a name="36" href="#36">36</a>  <em>     * &lt;p></em>
<a name="37" href="#37">37</a>  <em>     * A replacement for the Apache Commons {@link org.apache.commons.collections.MapUtils#putAll(Map, Object[]) MapUtils#putAll(Map, Object[])}</em>
<a name="38" href="#38">38</a>  <em>     * method. That one is very useful but requires a (usually empty) map as an input parameter and</em>
<a name="39" href="#39">39</a>  <em>     * does not support generics, leading to lots of casts and &lt;code>@SuppressWarnings&lt;/code> </em>
<a name="40" href="#40">40</a>  <em>     * declarations.</em>
<a name="41" href="#41">41</a>  <em>     * &lt;p></em>
<a name="42" href="#42">42</a>  <em>     * &lt;strong>Use with care:&lt;/strong> The method may well support generics, but it is &lt;strong></em>
<a name="43" href="#43">43</a>  <em>     * &lt;u>not runtime typesafe&lt;/u>&lt;/strong>! Because the runtime type of the map is </em>
<a name="44" href="#44">44</a>  <em>     * {@code &lt;Object, Object>}, values not compatible with the generic type declaration can </em>
<a name="45" href="#45">45</a>  <em>     * be inserted (without causing an error!) if the {@code keysAndValues} argument is not </em>
<a name="46" href="#46">46</a>  <em>     * properly constructed.</em>
<a name="47" href="#47">47</a>  <em>     * &lt;p></em>
<a name="48" href="#48">48</a>  <em>     * This can lead to tricky {@code ClassCastExceptions}, potentially in very distant parts of</em>
<a name="49" href="#49">49</a>  <em>     * the code.</em>
<a name="50" href="#50">50</a>  <em>     * </em>
<a name="51" href="#51">51</a>  <em>     * @param &lt;U> the type of the keys</em>
<a name="52" href="#52">52</a>  <em>     * @param &lt;V> the type of the values</em>
<a name="53" href="#53">53</a>  <em>     * @param keysAndValues an array of keys and values (the item at index &lt;code>i&lt;/code> is treated</em>
<a name="54" href="#54">54</a>  <em>     *                      as the key, &lt;code>i+1&lt;/code> is the value) to be added</em>
<a name="55" href="#55">55</a>  <em>     * @return  a new map containing the keys and values added</em>
<a name="56" href="#56">56</a>  <em>     * @throws cf. {@linkplain org.apache.commons.collections.MapUtils#putAll(Map, Object[])}</em>
<a name="57" href="#57">57</a>  <em>     * @see #toMap(Map, Object...)</em>
<a name="58" href="#58">58</a>  <em>     * @see org.apache.commons.collections.MapUtils#putAll(Map, Object[])</em>
<a name="59" href="#59">59</a>  <em>     */</em>
<a name="60" href="#60">60</a>      <strong>public</strong> <strong>static</strong> &lt;U, V> Map&lt;U, V> toMap(Object... keysAndValues) {
<a name="61" href="#61">61</a>          <strong>return</strong> toMap(<strong>new</strong> HashMap&lt;U, V>(), keysAndValues);
<a name="62" href="#62">62</a>      }
<a name="63" href="#63">63</a>      
<a name="64" href="#64">64</a>      <em>/**<em>*</em></em>
<a name="65" href="#65">65</a>  <em>     * Puts all the keys and values from the specified array into the target map. This</em>
<a name="66" href="#66">66</a>  <em>     * enables the caller to determine the map subclass used.</em>
<a name="67" href="#67">67</a>  <em>     * &lt;p></em>
<a name="68" href="#68">68</a>  <em>     * A replacement for the {@link org.apache.commons.collections.MapUtils#putAll(Map, Object[])}</em>
<a name="69" href="#69">69</a>  <em>     * method, supporting generics.</em>
<a name="70" href="#70">70</a>  <em>     * &lt;p></em>
<a name="71" href="#71">71</a>  <em>     * &lt;strong>Use with care:&lt;/strong> The method may well support generics, but it is &lt;strong></em>
<a name="72" href="#72">72</a>  <em>     * &lt;u>not runtime typesafe&lt;/u>&lt;/strong>! Because the runtime type of the map is </em>
<a name="73" href="#73">73</a>  <em>     * {@code &lt;Object, Object>}, values not compatible with the generic type declaration can </em>
<a name="74" href="#74">74</a>  <em>     * be inserted (without causing an error!) if the {@code keysAndValues} argument is not </em>
<a name="75" href="#75">75</a>  <em>     * properly constructed.</em>
<a name="76" href="#76">76</a>  <em>     * &lt;p></em>
<a name="77" href="#77">77</a>  <em>     * This can lead to tricky {@code ClassCastExceptions}, potentially in very distant parts of</em>
<a name="78" href="#78">78</a>  <em>     * the code.</em>
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>  <em>     * @param &lt;T> the type of the target map</em>
<a name="81" href="#81">81</a>  <em>     * @param targetMap the map to which the key/value pairs are to be added</em>
<a name="82" href="#82">82</a>  <em>     * @param keysAndValues an array of keys and values (the item at index &lt;code>i&lt;/code> is treated</em>
<a name="83" href="#83">83</a>  <em>     *                      as the key, &lt;code>i+1&lt;/code> is the value) to be added</em>
<a name="84" href="#84">84</a>  <em>     * @return  a new map containing the keys and values added</em>
<a name="85" href="#85">85</a>  <em>     * @throws cf. {@linkplain org.apache.commons.collections.MapUtils#putAll(Map, Object[])}</em>
<a name="86" href="#86">86</a>  <em>     * @see #toMap(Map, Object...)</em>
<a name="87" href="#87">87</a>  <em>     * @see org.apache.commons.collections.MapUtils#putAll(Map, Object[])</em>
<a name="88" href="#88">88</a>  <em>     */</em>
<a name="89" href="#89">89</a>      @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="90" href="#90">90</a>      <strong>public</strong> <strong>static</strong> &lt;T <strong>extends</strong> Map&lt;?, ?>> T toMap(T targetMap, Object... keysAndValues) {
<a name="91" href="#91">91</a>          <strong>return</strong> (T) org.apache.commons.collections.MapUtils.putAll(
<a name="92" href="#92">92</a>                  targetMap, keysAndValues);
<a name="93" href="#93">93</a>      }    
<a name="94" href="#94">94</a>      
<a name="95" href="#95">95</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

